/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.program.dataitem;

import static org.hisp.dhis.parser.expression.ParserUtils.DEFAULT_DATE_VALUE;
import static org.hisp.dhis.parser.expression.antlr.ExpressionParser.ExprContext;

import org.hisp.dhis.antlr.ParserExceptionWithoutContext;
import org.hisp.dhis.parser.expression.CommonExpressionVisitor;
import org.hisp.dhis.parser.expression.ProgramExpressionParams;
import org.hisp.dhis.parser.expression.antlr.ExpressionParser;
import org.hisp.dhis.program.ProgramExpressionItem;
import org.hisp.dhis.program.ProgramStage;

/**
 * Program indicator expression data item PS_EVENTDATE: programStageUid
 *
 * @author Jim Grace
 */
public class ProgramItemPsEventdate extends ProgramExpressionItem {
  @Override
  public Object getDescription(ExprContext ctx, CommonExpressionVisitor visitor) {
    String programStageUid = ctx.uid0.getText();

    ProgramStage programStage = visitor.getProgramStageService().getProgramStage(programStageUid);

    if (programStage == null) {
      throw new ParserExceptionWithoutContext("Program stage " + ctx.uid0.getText() + " not found");
    }

    visitor.getItemDescriptions().put(programStageUid, programStage.getDisplayName());

    return DEFAULT_DATE_VALUE;
  }

  @Override
  public final Object getSql(ExpressionParser.ExprContext ctx, CommonExpressionVisitor visitor) {
    ProgramExpressionParams params = visitor.getProgParams();

    return visitor
        .getStatementBuilder()
        .getProgramIndicatorEventColumnSql(
            ctx.uid0.getText(),
            "occurreddate",
            params.getReportingStartDate(),
            params.getReportingEndDate(),
            params.getProgramIndicator());
  }
}
